home *** CD-ROM | disk | FTP | other *** search
/ Aminet 33 / Aminet 33 - October 1999.iso / Aminet / util / shell / ViNCEd.lha / ViNCEd / Localize! / ReadMe < prev    next >
Encoding:
Text File  |  1998-10-03  |  4.9 KB  |  112 lines
  1. ******************************************************************************
  2. ** ViNCEd localization package                                              **
  3. **                                                                          **
  4. ** © 1990-1998 THOR-Software,    Thomas Richter                              **
  5. **      Version 41.00                                                       **
  6. **                                                                          **
  7. ** All the restrictions of the THOR-Software licence apply to this package  **
  8. ** read the VNC.guide to find out more about this licence                   **
  9. ******************************************************************************
  10.  
  11. This is the localization package for THOR's ViNCEd shell editor. 
  12.  
  13. Since at the time of writing ViNCEd, I had no access to the commodore 
  14. standard localization tools, ViNCEd's locale is setup by a private program,
  15. called CreateCatalog. There are many pro's and con's about this program,
  16. and propably even more con's than pro's, but at least it is freely dis-
  17. tributable (only the licence applies), and it is sometimes more flexible
  18. than the standard tool. The CreateCatalog tool takes only one input file,
  19. the .construct file. This file has two purposes and can be read thanks to
  20. the unique CreateCatalog syntax by both the shell and CreateCatalog itself.
  21. First, it is a shell script that has to be executed by the "Execute" command
  22. to build the complete catalog. Second, it acts as a command file for
  23. CreateCatalog, which contains the localized strings, plus some comments
  24. plus links to files with more strings. So don't worry if something seems
  25. to miss: The .construct file is good enough and contains all information.
  26.  
  27.  
  28. Here's a step-by-step instruction how to localize ViNCEd:
  29.  
  30. 1) "CD" into this directory.
  31.  
  32. 2) Edit the "sys.construct" file, follow the instructions there. You need to 
  33. change the name of the language, and the requester and menu texts. The 
  34. english versions of the strings are present there as well. 
  35.  
  36. The only thing worth remembering is:
  37.  
  38. The first character of a line determinates the meaning of a line:
  39. A blank (or TAB) or a semicolon ";" are used to introduce a comment line.
  40. These lines are ingored by CreateCatalog (and by the shell script).
  41. A ' (apostrophe) is an actual string that is put into the locate database.
  42. Only these lines must be translated.
  43. A # (hash mark) line sets the string counter to a specific value. Do not
  44. edit these lines.
  45. A % (percent sign) sets a size limit for texts. This limit is either given
  46. by a number, or a sequence of dashes. "CreateCatalog" counts the number of
  47. dashes and limits the string length by this number. This has the advantage
  48. that you can just check by "one look" whether your strings are too long or
  49. not.
  50.  
  51. Since all the catalog creators are taken from the german localization, the
  52. current strings in the locale database are german. Don't mind about this,
  53. I always added the english original version of the string ON TOP of the
  54. german version, plus some information when this string is used.
  55.  
  56. 3) Now build the locale. Only one command should suffer:
  57.  
  58. >Execute sys.construct
  59.  
  60. The complete locale database will be put into your RAM: drawer and will be
  61. called "VNC.sys.catalog". Create a subdirectory "VNC" in your catalog
  62. drawer "LOCALE:CATALOGS/<language>" and copy this file there.
  63.  
  64. 4) Now edit the "prefs.construct" file. It contains all strings for the
  65. prefs editor "SetVNC". 
  66.  
  67. 5) Build the catalog by one command:
  68.  
  69. >Execute prefs.construct
  70.  
  71.  
  72. A file "VNC.prefs.catalog" should appear in the RAM drawer.
  73.  
  74.  
  75. 6) Copy this file to LOCALE:Catalogs/<language>/VNC.
  76.  
  77.  
  78. 7) Setup the language with the prefs editor "Locale" of the workbench.
  79. Open a ViNCEd window and open the prefs editor. Check if your localization
  80. looks properly: Check for example if some of your strings are too long
  81. and leak over the boundaries of the gadgets. Usually the size of the menu
  82. is adapted from the strings in it, however a very big menu may look ugly
  83. again. It might happen that your first try is not very con-vince-ing, so
  84. write down the strings that caused the problems and correct them.
  85. Repeat steps 3 to 12 until the result is acceptable.
  86.  
  87.  
  88. 8) If you like, update the installer script of the ViNCEd package.
  89. If you don't know how to do this, just translate the english or german
  90. strings in there, and send me the translated version.
  91.  
  92.  
  93. 9) If you have still plenty of time (I don't expect this do be done ;-)
  94. translate the guide. This is maybe a lot of work, two weeks of typing...
  95. ;-) Well, as I said, unless you've plenty of time....
  96.  
  97.  
  98. 10) If you're finally happy with your translations, don't forget to mail
  99. them to my address so I can put them into the next release of ViNCEd. Here's
  100. my mail address:
  101.  
  102.         thor@math.tu-berlin.de
  103.  
  104. Please send the locale databases (plus the installer, plus the guide) as
  105. an uuencoded lha archive to this address. If you have trouble with
  106. CreateCatalog, please let me know, too.
  107.  
  108.  
  109. Thanks a lot for your work,
  110.         Thomas
  111.  
  112.